From 885a80efe8281395da0f3cc19b2eb59d25bce4a9 Mon Sep 17 00:00:00 2001 From: Dakota Rennemann Date: Sun, 17 May 2020 05:28:01 -0400 Subject: [PATCH] Cleaning up documentation --- README.md | 6 +++--- client/README.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d46bc7aa..2da86d71 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ ### `/` - #### `client/` - [Client](/client/#client) is the frontend of the application. It is powered by [React](https://reactjs.org/) and [Blockly](https://developers.google.com/blockly). + [Client](/client#client) is the frontend of the application. It is powered by [React](https://reactjs.org/) and [Blockly](https://developers.google.com/blockly). - #### `cms/` @@ -15,14 +15,14 @@ - #### `compile/` - [Compile](/compile/#compile) is an arduino compiler service. It is an unofficial fork of [Chromeduino](https://github.com/spaceneedle/Chromeduino). + [Compile](/compile#compile) is an arduino compiler service. It is an unofficial fork of [Chromeduino](https://github.com/spaceneedle/Chromeduino).
## Setup ### Development -This project's dependencies are managed through [yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable) +This project's dependencies are managed through [yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable). This effectively replaces npm and should be used in place of npm everywhere except sc-compile-dev. The following are the available scripts we can use with the client and server: The development environment is comprised of four servers managed by docker compose. diff --git a/client/README.md b/client/README.md index 4c4fe6a4..7ebcaf2b 100644 --- a/client/README.md +++ b/client/README.md @@ -1,6 +1,6 @@ # Client -[React.js](https://reactjs.org/) application which represents the entire browserside client. Filestructure is standard for a [create-react-app](https://github.com/facebook/create-react-app) application with some minor changes. Any component which represents an entire page is categorized under the [views](/src/views) folder. +[React.js](https://reactjs.org/) application which represents the entire browserside client. File structure is standard for a [create-react-app](https://github.com/facebook/create-react-app) application with some minor changes. Any component which represents an entire page is categorized under the [views](/client/src/views) folder.