Skip to content
This repository was archived by the owner on Jul 14, 2023. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
19 changes: 11 additions & 8 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.

15 changes: 8 additions & 7 deletions docs/linux-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```