esamattis / esamattis/underscore.string

Provide build instructions

Aperta
#205 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub
candidate
Lingua principale
JavaScript
Stelle
3.4k
Fork
367
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Version 3 may be on the road to Grunt (#163) but while we still have the Rakefile the README should have a little advice on how to build.

I found two issues.

The Rakefile uses Ruby 1.9's new hash syntax, so running `rake` in 1.8 (still the default on Mac) will throw up this error:

```
rake aborted!
/Users/cjoslyn/Code/underscore.string/Rakefile:2: syntax error, unexpected ':', expecting $end
task default: :test
^
```

If you know of a nice set of ruby 1.9 installation instructions, please link to them. There are probably at least a few [gotchas](http://stackoverflow.com/a/8237833/199644).

Also, since you're using Gemfile.lock, take care to remind intrepid builders that in order to use the right versions of everything they should run `bundle install` and to use `bundle exec rake` instead of `rake`.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Aggiorna il README usando come punti di partenza i dettagli di build presenti in Rakefile e Gemfile.lock. Documenta il requisito di Ruby 1.9, inserisci un link alle istruzioni di installazione e spiega l'esecuzione di bundle install seguita da bundle exec rake; il lavoro è completo quando il README copre entrambi i problemi di build segnalati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
ruby
Ambito
build-system, documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.