From e65d67c28a712c9e64f916708eb98dc23b2e781f Mon Sep 17 00:00:00 2001 From: Vladislav Trotsenko Date: Tue, 8 Feb 2022 09:26:56 +0200 Subject: [PATCH] Technical/Update documentation (#11) * Updated script documentation * Updated version, changelog --- CHANGELOG.md | 6 ++++++ README.md | 13 +++++++++++-- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 355267b..b6fd8d7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index 693cfac..82da314 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: @@ -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 ```