mirrors/dotnet-installer
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Add contrib guidelines, Docker links

Browse source 
Add contribution guidelines. These just link to the CoreCLR ones. Add
stubs of the "user guide" and "developer guide".
Add links to the Docker base image repo on GitHub.
This commit is contained in:
Zlatko Knezevic 2015-11-16 12:22:11 -08:00
parent 5156afa505
commit 7b975aeeac
3 changed files with 64 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,5 +1,7 @@
# .NET Command Line Interface
This repo contains the source code for cross-platform [.NET Core](http://github.com/dotnet/core) command line toolchain. It contains the implementation of each command, the native packages for various supported platforms as well as documentation.
Build Status
------------
@ -16,28 +18,12 @@ Installers
|**Installers**|[Download Debian Package](https://dotnetcli.blob.core.windows.net/dotnet/dev/Installers/Latest/dotnet-linux-x64.latest.deb)|[Download Msi](https://dotnetcli.blob.core.windows.net/dotnet/dev/Installers/Latest/dotnet-win-x64.latest.msi)|[Download Pkg](https://dotnetcli.blob.core.windows.net/dotnet/dev/Installers/Latest/dotnet-osx-x64.latest.pkg) |
|**Binaries**|[Download tar file](https://dotnetcli.blob.core.windows.net/dotnet/dev/Binaries/Latest/dotnet-linux-x64.latest.tar.gz)|[Download zip file](https://dotnetcli.blob.core.windows.net/dotnet/dev/Binaries/Latest/dotnet-win-x64.latest.zip)|[Download tar file](https://dotnetcli.blob.core.windows.net/dotnet/dev/Binaries/Latest/dotnet-osx-x64.latest.tar.gz) |
## Prerequisites
Docker
------
In order to build dotnet-cli, you need the following installed on you machine
You can also use our Docker base images found on http://github.com/dotnet/dotnet-docker to set up your dev or testing environment for usage.
### For Windows
Questions & Comments
--------------------
1. Visual Studio 2015 with Web Development Tools
* Beta8 is available here and should work: http://www.microsoft.com/en-us/download/details.aspx?id=49442
* Install `WebToolsExtensionsVS14.msi` and `DotNetVersionManager-x64.msi`
2. CMake (available from https://cmake.org/) is required to build the native host `corehost`. Make sure to add it to the PATH.
## Building/Running
1. Run `build.cmd` or `build.sh` from the root
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.
## Visual Studio Code
* You can also use Visual Studo code https://code.visualstudio.com/
## A simple test
1. `cd test\TestApp`
2. `dotnet run`
For any and all feedback, please use the Issues on this repository.

9
documentation/Contributing.md Normal file
View file

@ -0,0 +1,9 @@
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.

51
documentation/README.md
View file

@ -1,7 +1,50 @@
# Documentation
## Developer getting started guide
# Start developing on .NET Command Line Interface
## Prerequisites
In order to build .NET Command Line Interface, you need the following installed on you machine.
### For Windows
1. Visual Studio 2015 with Web Development Tools
* Beta8 is available here and should work: http://www.microsoft.com/en-us/download/details.aspx?id=49442
* Install `WebToolsExtensionsVS14.msi` and `DotNetVersionManager-x64.msi`
2. CMake (available from https://cmake.org/) is required to build the native host `corehost`. Make sure to add it to the PATH.
### For Linux
You need CMake in your path.
### For OS X
[TODO]
## User getting started guide
[TODO]
## Building/Running
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.
# 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
1. `cd test\TestApp`
2. `dotnet run`
## Contributing to the repo
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.
# 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.