Skip to content

Technical/Update documentation #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bestwebua merged 1 commit into from
Feb 8, 2022
Merged

Technical/Update documentation #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.2.2] - 2022-02-08

### Updated

- Updated documentation

## [0.2.1] - 2022-02-08

### Updated
Expand Down
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# FRS - fast Ruby setup

Automation script for spin-up Ruby developer environment. Configure your developer stuff on Linux Ubuntu in minutes 🚀 Focus on development, not on developer tools!
Automation script for spinning-up Ruby developer environment. Configure your developer stuff on Linux Ubuntu in minutes 🚀 Focus on development, not on developer tools!

## Features

Expand All @@ -18,6 +18,10 @@ Automation script for spin-up Ruby developer environment. Configure your develop

## Using

### Get latest Ubuntu

Download and install latest [Ubuntu Desktop](https://ubuntu.com/download/desktop).

### Create GitHub personal access token

To create it go to: [`GitHub/Settings/Developer settings/Personal access tokens/New personal access token`](https://github.com/settings/tokens/new). Specify token name and next token scopes:
Expand All @@ -40,12 +44,17 @@ sudo apt-get install wget
wget https://raw.githubusercontent.com/RubyWorkout/frs/master/setup.sh
```

### Allow executable permissions

```bash
chmod +x setup.sh
```

### Run script

Run Fast Ruby Setup script with your email, name (registered on github), github username and github personal access token as positional arguments:

```bash
chmod +x setup.sh
. ./setup.sh johndoe@example.com "John Doe" git_username git_token
```

Expand Down