Skip to content

Commit ee74ca6

Browse files
committed
Update links to more mature documentation
1 parent 97f5e13 commit ee74ca6

File tree

1 file changed

+19
-29
lines changed

1 file changed

+19
-29
lines changed

readme.md

+19-29
Original file line numberDiff line numberDiff line change
@@ -18,41 +18,31 @@ ASP.net 5 can target the newly open sourced [CoreCLR](http://blogs.msdn.com/b/do
1818
### Easier Way
1919
The easier way to run this application is using the package hosted on GitHub:
2020

21-
1. Install the DNVM (a version manager for DNX runtimes).
22-
* Windows: Run this from a console window with administrator privileges: `@powershell -NoProfile -ExecutionPolicy unrestricted -Command "&{$Branch='dev';iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/aspnet/Home/dev/dnvminstall.ps1'))}"`.
23-
* OS X:
24-
1. [Install Homebrew](http://www.brew.sh).
25-
2. Run `brew tap aspnet/dnx`.
26-
3. Run `brew update`.
27-
4. Run `brew install dnvm`.
28-
* Linux: Follow [this guide](https://github.com/aspnet/Home/blob/dev/GettingStartedDeb.md); good luck.
29-
2. Run `dnvm upgrade` to install a version of the DNX.
30-
3. Download [the packaged application](https://github.com/kfritz/StreamMerge/releases/download/v1/StreamMerge.zip).
31-
4. Extract the zip archive.
32-
5. Start the application.
21+
1. Install a .NET Execution Environment (DNX).
22+
* [Windows installation instructions](http://docs.asp.net/en/latest/getting-started/installing-on-windows.html#install-asp-net-standalone)
23+
* [OS X installation instructions](http://docs.asp.net/en/latest/getting-started/installing-on-mac.html#install-asp-net-5-on-os-x)
24+
* [Linux installation instructions](http://docs.asp.net/en/latest/getting-started/installing-on-linux.html#installing-asp-net-5-on-linux)
25+
2. Download [the packaged application](https://github.com/kfritz/StreamMerge/releases/download/v1/StreamMerge.zip).
26+
3. Extract the zip archive.
27+
4. Start the application.
3328
* Windows: run `web.cmd`.
3429
* Bash: run `web`.
35-
6. Issue GET requests to http://localhost:5000/quiz/merge with the appropriate query string parameters.
30+
5. Issue GET requests to http://localhost:5000/quiz/merge with the appropriate query string parameters.
3631

3732
### Harder Way
3833

3934
To run the application from scratch, one must [clone this repository](http://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository) and then [setup DNX](https://github.com/aspnet/Home/blob/dev/README.md). Once DNX is installed (either on Windows, OS X, or Linux), one should go through the process of getting the required packages in position and starting the runtime.
4035

41-
1. Install the DNVM (a version manager for DNX runtimes).
42-
* Windows: Run this from a console window with administrator privileges: `@powershell -NoProfile -ExecutionPolicy unrestricted -Command "&{$Branch='dev';iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/aspnet/Home/dev/dnvminstall.ps1'))}"`.
43-
* OS X:
44-
1. [Install Homebrew](http://www.brew.sh).
45-
2. Run `brew tap aspnet/dnx`.
46-
3. Run `brew update`.
47-
4. Run `brew install dnvm`.
48-
* Linux: Follow [this guide](https://github.com/aspnet/Home/blob/dev/GettingStartedDeb.md); good luck.
49-
2. Run `dnvm upgrade` to install a version of the DNX.
50-
3. Clone this repository.
51-
4. Change directories to the root of the cloned repository.
52-
5. Run `dnu restore` to restore the required packages.
53-
6. Change directories to .\src\StreamMerge.
54-
7. Start the application with the command `dnx . web` on Windows or `dnx . kestrel` on OS X/Linux.
55-
8. Issue GET requests to http://localhost:5000/quiz/merge with the appropriate query string parameters.
36+
1. Install a .NET Execution Environment (DNX).
37+
* [Windows installation instructions](http://docs.asp.net/en/latest/getting-started/installing-on-windows.html#install-asp-net-standalone)
38+
* [OS X installation instructions](http://docs.asp.net/en/latest/getting-started/installing-on-mac.html#install-asp-net-5-on-os-x)
39+
* [Linux installation instructions](http://docs.asp.net/en/latest/getting-started/installing-on-linux.html#installing-asp-net-5-on-linux)
40+
2. Clone this repository.
41+
3. Change directories to the root of the cloned repository.
42+
4. Run `dnu restore` to restore the required packages.
43+
5. Change directories to .\src\StreamMerge.
44+
6. Start the application with the command `dnx . web` on Windows or `dnx . kestrel` on OS X/Linux.
45+
7. Issue GET requests to http://localhost:5000/quiz/merge with the appropriate query string parameters.
5646

5747
Note, I haven't actually tried this on OS X and Linux; your mileage may vary.
5848

@@ -65,4 +55,4 @@ No future work is actually planned for this project. However, if there were to
6555

6656
* **Unit test coverage of corner cases** - The test as written now is simply a quick check that streams are merged and state is preserved between invocations. Better test coverage should be added to cover corner cases. For example, what happens when the application is invoked with overlapping stream names? The quiz prompt was vague on this point, so the behavior right now is undefined.
6757
* **Configurable target API** - The address of the Peloton API is presently hard coded into `StreamClient`. This should instead be driven by configuration files so that one can retarget the application to a different location like a sandbox API instance. This could be implemented using the [`IConfiguration` contract](http://whereslou.com/2014/05/23/asp-net-vnext-moving-parts-iconfiguration/).
68-
* **More expressive input contract** - The quiz prompt only asked to merge two named streams. The `IStreamRepository` contract, though, is capable of merging any positive number of streams. Extending this capability to consumers of StreamMerge could be valuable.
58+
* **More expressive input contract** - The quiz prompt only asked to merge two named streams. The `IStreamRepository` contract, though, is capable of merging any positive number of streams. Extending this capability to consumers of StreamMerge could be valuable.

0 commit comments

Comments
 (0)