Merge pull request #227 from dotnet/framing

Move to same format as other Core Repos
This commit is contained in:
Rich Lander 2015-11-17 23:44:04 -08:00
commit 3de596f48d
4 changed files with 17 additions and 31 deletions

9
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,9 @@
Contributing
============
See [Contributing](https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/contributing.md) for information about coding styles, source structure, making pull requests, and more.
Developers
==========
See the [Developer Guide](Documentation/developer-guide.md) for details about developing in this repo.

4
Documentation/README.md Normal file
View file

@ -0,0 +1,4 @@
Documents Index
===============
- [Developer Guide](developer-guide.md)

View file

@ -1,5 +1,6 @@
Developer Guide
===============
# Start developing on .NET Command Line Interface
## Prerequisites ## Prerequisites
In order to build .NET Command Line Interface, you need the following installed on you machine. In order to build .NET Command Line Interface, you need the following installed on you machine.
@ -28,29 +29,14 @@ In order to build .NET Command Line Interface, you need the following installed
1. Run `build.cmd` or `build.sh` from the root depending on your OS. 1. Run `build.cmd` or `build.sh` from the root depending on your OS.
2. Use `artifacts/{os}-{arch}/stage2/dotnet` to try out the `dotnet` command. You can also add `artifacts/{os}-{arch}/stage2` to the PATH if you want to run `dotnet` from anywhere. 2. Use `artifacts/{os}-{arch}/stage2/dotnet` to try out the `dotnet` command. You can also add `artifacts/{os}-{arch}/stage2` to the PATH if you want to run `dotnet` from anywhere.
# Tools
## Visual Studio
* You can use Visual Studio 2015 to work on these bits.
## Visual Studio Code
* You can also use Visual Studo code https://code.visualstudio.com/ to contribute to this project.
## A simple test ## A simple test
1. `cd test\TestApp` 1. `cd test\TestApp`
2. `dotnet run` 2. `dotnet run`
# Contributing to the repo
## Contribution Guidelines ##Adding a Command
Once you are set up with requirements and you want to start, please review our [contribution guidelines](Contributing.md) to get up to speed with the process.
### Adding a Command
The donet CLI considers any executable on the path named `dotnet-{commandName}` to be a command it can call out to. `dotnet publish`, for example, is added to the path as an executable called `dotnet-publish`. To add a new command we must create the executable and then add it to the distribution packages for installation. The donet CLI considers any executable on the path named `dotnet-{commandName}` to be a command it can call out to. `dotnet publish`, for example, is added to the path as an executable called `dotnet-publish`. To add a new command we must create the executable and then add it to the distribution packages for installation.
0. Create an issue on https://github.com/dotnet/cli and get consensus on the need for and behavior of the command. 0. Create an issue on https://github.com/dotnet/cli and get consensus on the need for and behavior of the command.
@ -76,8 +62,4 @@ Each command's project root should contain a manpage-style Readme.md that descri
3. run *build* from the root directory and make sure your project is producing binaries in /artifacts/ 3. run *build* from the root directory and make sure your project is producing binaries in /artifacts/
#### Add command to packages #### Add command to packages
- Update the symlinks property of debian_config.json to include the new command - Update the symlinks property of debian_config.json to include the new command
# I just want to use this toolchain
If you just want to use the .NET Command Line Interface, your best bet would be to use the installers provided on the [main README file](../README.md). You can also follow the above guide for building from source to get the lastest (bleeding edge) bits.

View file

@ -1,9 +0,0 @@
Contributing to .NET Command Line Interface
===========================================
The .NET Core team maintains several guidelines for contributing to the .NET Core and associated repos, which are provided [on this link](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/contributing.md). Many of these are straightforward, while others may seem subjective. A .NET Core team member will be happy to explain why a guideline is defined as it is.
Developers
==========
See the [README.md](readme.md) file in this directory for more details on how to get started developing on the .NET Command Line Interface.