diff --git a/docs/README.md b/docs/README.md index ee274648..246bc9bb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # GitHub Classroom Assistant Documentation -Classroom Assistant is a cross-platform desktop application to help you get student repositories for grading. +Classroom Assistant is a cross-platform desktop application that will help you to get student's repositories for grading. ## Platforms GitHub Classroom Assistant has been officially tested on these platforms. There are [known issues](./linux-issues.md) on some distributions on Linux that we welcome contributions for. diff --git a/docs/development.md b/docs/development.md index 73fe04a7..558dc3aa 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,29 +1,32 @@ -# Installing for Development +# Set-Up for Development -A local version is simple to set up: +Setting up your local environment: ```sh git clone https://github.com/education/classroom-assistant cd classroom-assistant -script/setup ``` +Install dependencies: -Once installed, run the application with +``` +script/setup +``` +Run the application: ``` script/run ``` -## Building +## Build the application -You can build Classroom Assistant into executables by running +You can build Classroom Assistant into executable: ``` script/package ``` -Please follow platform-specific instructions below: +Please follow `MacOS` specific instructions below: ### MacOS @@ -42,5 +45,5 @@ You can retrieve a list of developer identities available in your keychain by ru security find-identity -p codesigning ``` -Do this and all will be well +Now, Good to Go. diff --git a/docs/linux-issues.md b/docs/linux-issues.md index 54d101de..a8e5a362 100644 --- a/docs/linux-issues.md +++ b/docs/linux-issues.md @@ -4,13 +4,14 @@ There are known issues with some distributions of Linux, we recommend using Ubun ## Protocol Handler The command we use to set up the custom protocol handler for Classroom Assistant fails on some distros. -You can try setting it manually by running: - -`xdg-settings set default-url-scheme-handler x-github-classroom classroom-assistant.desktop` - -For XFCE based desktops, `xdg-settings` does not seem to work, you have to manually set up the protocol handling for the application to work. +You can try to set it up manually by running: +``` +xdg-settings set default-url-scheme-handler x-github-classroom classroom-assistant.desktop +``` +For XFCE-based desktops, `xdg-settings` does not seem to work, you have to manually set up the protocol handling for the application to work. ## KDE The package we use for storing tokens on Linux needs an additional dependency on KDE. This can be installed with - -`sudo apt-get install gnome-keyring` +``` +sudo apt-get install gnome-keyring +``` \ No newline at end of file