Skip to content

Commit

Permalink
updated gemspec
Browse files Browse the repository at this point in the history
  • Loading branch information
elotroalex committed Sep 28, 2022
1 parent 8812611 commit 97b6cce
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 12 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
_gh_pages
_site
.ruby-version
.jekyll-cache

# Numerous always-ignore extensions
*.diff
Expand Down
27 changes: 19 additions & 8 deletions documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,31 @@ author: Alex Gil

This documentation was built with beginners in mind, but has the necessary information for more seasoned producers.

To install and use Ed you will be using your terminal. If you need a refresher, I highly recommend "[The Command Line Crash Course](https://www.computervillage.org/articles/CommandLine.pdf)." Working knowledge of HTML and CSS is also taken for granted. If you're new to HTML and CSS, you may want to check out the relevant courses on [codecademy.com](https://www.codecademy.com/learn/web).
To install and use Ed you will be using your terminal. If you need a refresher, I highly recommend "[The Command Line Crash Course](https://www.computervillage.org/articles/CommandLine.pdf)." Working knowledge of HTML and CSS is also taken for granted. If you're new to HTML and CSS, you may want to check out the relevant courses on [codecademy.com](https://www.codecademy.com/catalog/language/html-css).

Jekyll does not run very well on Windows machines for now. If you are using Windows, this theme won't work for you, but we hope that you simply deploy our principles, and parts of our stylesheet, on a system like [Hugo](https://gohugo.io/), which does work on Windows.
Jekyll does not run very well on Windows machines. If you are using Windows, this theme can work for you with some difficulty. You can [struggle through it](https://jekyllrb.com/docs/installation/windows/), or simply deploy our principles, and parts of our stylesheet, on a system like [Hugo](https://gohugo.io/), which does work on Windows.

---

## Installing Ed: Easy
## Using Ed as a Template

The easy way to do this is not necessarily the more robust, and may simply not work on your system. The easy way could also be called the 'lucky' way. It will work if your system is ready for Ed. Two major caveats to keep in mind if you go the easy route: a) You may run into problems later when some Ed components need updating; and, b) You may run into conflicts if you run several Ruby environments for different projects. That said, if you just want to quickly try Ed, and you don't run into problems installing, this is perhaps the best approach.
You can use Ed on GitHub Pages for free, without a local installation, by editing the project files on github and using the template files. To use Ed this way you must have a Github account of your own. Once logged in, visit the [Github repository for Ed](https://github.com/minicomp/ed), and follow this steps:

a) Select **Use this template** (the big green button).
b) In the next page, name your new project. Remember to use only lowercase letters and no spaces.
c) Once you save your new settings, GitHub should take you to your new repository page. Select the **Settings** tab.
d) Once in **Settings** select **Pages**
e) In the **Pages** tab select the **main** branch from the **Branch** drop-down menu. Save. Your site will be built shortly. Give it a few minutes. GitHub will display the link to your published site shortly.

If you're using a Mac, make sure you have the appropriate version of [XCode command line tools](https://developer.apple.com/xcode/download/) for your OSX. Using the terminal's `cd` command, switch to the directory where you want to install your project. Once inside the folder, you are ready to download and start using Ed. Enter each of these lines into your terminal (remember to ignore the `$`):


## Installing Ed Locally



The easy way could also be called the 'lucky' way. It will work if your system is ready for Ed, that is, if you already have a working Ruby environment that you were using for another project. If you don't even know what that means, skip ahead.

Using the terminal's `cd` command, switch to the directory where you want to install your project. Once inside the folder, you are ready to download and start using Ed. Enter each of these lines into your terminal (remember to ignore the `$`):

~~~ bash
$ git clone https://github.com/minicomp/ed.git
Expand Down Expand Up @@ -58,9 +71,7 @@ $ git --version

If you don't get an error, you're good to go. Using the `cd` command on your terminal, navigate to the folder where you keep your web projects. Once you're in the folder where you want Ed to live, download it from github using the following line (remember you can copy and paste):

~~~ bash
$ git clone https://github.com/minicomp/ed.git
~~~


At this point you should navigate inside your Ed project folder and stay there until further notice:

Expand Down
8 changes: 4 additions & 4 deletions ed..gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Gem::Specification.new do |spec|

spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(404|assets|optional|_layouts|_includes|_sass|_texts|index|search|about|credits|documentation|atom|Gemfile|LICENSE|README)}i) }

spec.add_runtime_dependency "jekyll", "~> 3.6"

spec.add_development_dependency "bundler", ">= 1.16"
spec.add_development_dependency "rake", ">= 12.3.3"
spec.add_runtime_dependency "jekyll", "~> 4.2.0"
spec.add_development_dependency "bundler", ">= 2.3"
spec.add_development_dependency "rake", ">= 13.0"
spec.add_development_dependency "webrick", ">= 1.7"
end

0 comments on commit 97b6cce

Please sign in to comment.