From 798b2890d077d7f79bd254eae609009e4d6a653e Mon Sep 17 00:00:00 2001 From: Alys Date: Fri, 31 Jul 2015 17:55:16 +1000 Subject: [PATCH] HabitRPG -> Habitica text changes --- CONTRIBUTING.md | 4 ++-- DOCS-README.md | 38 ++++++++++++++++----------------- README.md | 10 ++++----- VAGRANT.md | 8 +++---- common/README.md | 2 +- vagrant.sh | 10 ++++----- website/public/front/README.md | 4 ++-- website/src/controllers/auth.js | 6 +++--- 8 files changed, 41 insertions(+), 41 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b3259456fb8..8538befabf6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,8 +7,8 @@ You might find help with your issue on the [Frequently Asked Questions](http://h # Requesting a feature -HabitRPG uses [Trello](https://trello.com/b/EpoYEYod/habitrpg) to track feature requests. [Read more](https://trello.com/c/odmhIqyW/440-read-first-table-of-contents). +Habitica uses [Trello](https://trello.com/b/EpoYEYod/habitrpg) to track feature requests. [Read more](https://trello.com/c/odmhIqyW/440-read-first-table-of-contents). # Contributing Code -See [Contributing to HabitRPG](http://habitrpg.wikia.com/wiki/Contributing_to_HabitRPG#Coders_.28Web_.26_Mobile.29) +See [Contributing to Habitica](http://habitica.wikia.com/wiki/Contributing_to_Habitica#Coders_.28Web_.26_Mobile.29) diff --git a/DOCS-README.md b/DOCS-README.md index e21c420b162..c3660fd0706 100644 --- a/DOCS-README.md +++ b/DOCS-README.md @@ -1,23 +1,23 @@ -# HabitRPG Docs Project +# Habitica Docs Project -Generated documentation for all of HabitRPG's source files will be kept in the folder and subfolders. If you would like to use the existing documentation, or contribute to the documentation efforts, read on. +Generated documentation for all of Habitica's source files will be kept in the folder and subfolders. If you would like to use the existing documentation, or contribute to the documentation efforts, read on. ## Viewing Docs -You're looking at it! +You're looking at it! -Unless you are viewing this file directly from GitHub, you should see a list of files and folders to the left of this readme. +Unless you are viewing this file directly from GitHub, you should see a list of files and folders to the left of this readme. -If you are working locally, you can goto `localhost:3000/docs/` and view the Docs. +If you are working locally, you can goto `localhost:3000/docs/` and view the Docs. -All documentation is generated from comments in the code, into HTML files in the `public/docs/` folder. After you have cloned the HabitRPG repo locally, and done all the `npm install` goodness, the Docs should generate automagickly when you run `grunt run:dev` +All documentation is generated from comments in the code, into HTML files in the `public/docs/` folder. After you have cloned Habitica's repo locally, and done all the `npm install` goodness, the Docs should generate automagickly when you run `grunt run:dev` ## What I do now? -Well if you know Markdown, simply add detailed comments in the code using Markdown syntax. +Well if you know Markdown, simply add detailed comments in the code using Markdown syntax. ```` -/* +/* User.js ======= @@ -32,35 +32,35 @@ var helpers = require('habitrpg-shared/script/helpers'); var _ = require('lodash');.... ```` -As you can see, you can use both multiline style comments `/* fancy stuff */` and inline comments `// Ooooh my`. +As you can see, you can use both multiline style comments `/* fancy stuff */` and inline comments `// Ooooh my`. -The exception being end of line comments +The exception being end of line comments `text: String, // example: Wolf ` The above will not be on the "pretty print" side of the Docs, but will stay in the code. An example use case for end of line comments would be for FIXME notes. -Add anything that would be helpful to a developer regarding how to use the functions, variables, and objects associated with HabitRPG. +Add anything that would be helpful to a developer regarding how to use the functions, variables, and objects associated with Habitica. -**All documentation should be committed as pull request to the `docs-project` branch of HabitRPG.** Since we are adding comments directly to the code, I don't want to be editing files used for beta or master. We can merge in the docs after we're sure we didn't break anything. +**All documentation should be committed as pull request to the `docs-project` branch of Habitica's repo.** Since we are adding comments directly to the code, I don't want to be editing files used for beta or master. We can merge in the docs after we're sure we didn't break anything. ### jsDoc Syntax -Yes, the generator also supports jsDoc-style comments such as +Yes, the generator also supports jsDoc-style comments such as ```` @param {Array} files Array of file paths relative to the `inDir` to generate documentation for. ```` **Important Note:** If you use the `@param` syntax, you must use multiline comment blocks (ie `/* stuff */`), otherwise they won't be parsed like parameters. -This may or may not be useful for HabitRPG. Example use cases: -- Documenting the API +This may or may not be useful for Habitica. Example use cases: +- Documenting the API - Javascript Models ## Okay, I added great comments. Now what? If you're running locally, just re-run `grunt run:dev`. Any changed docs will be automagickly updated. -Once you're satisfied with the output, push your changes to your fork of HabitRPG and issue a Pull Request on the `docs-project` branch. +Once you're satisfied with the output, push your changes to your fork of the repo and issue a Pull Request on the `docs-project` branch. It's that easy! @@ -72,6 +72,6 @@ We also use the [Grunt-Docker](https://github.com/Prevole/grunt-docker) node mod ## Road Map -- Customize CSS with HabitRPG specific Styling -- Explore possibilities of importing Wiki content -- Specify style guide for consistency of comments \ No newline at end of file +- Customize CSS with Habitica-specific Styling +- Explore possibilities of importing Wiki content +- Specify style guide for consistency of comments diff --git a/README.md b/README.md index 7c7ad551721..62854c23ed6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -HabitRPG [![Build Status](https://travis-ci.org/HabitRPG/habitrpg.png?branch=develop)](https://travis-ci.org/HabitRPG/habitrpg) [![Code Climate](https://codeclimate.com/github/HabitRPG/habitrpg.png)](https://codeclimate.com/github/HabitRPG/habitrpg) [![Coverage Status](https://coveralls.io/repos/HabitRPG/habitrpg/badge.svg?branch=develop)](https://coveralls.io/r/HabitRPG/habitrpg?branch=develop) [![Bountysource](https://api.bountysource.com/badge/tracker?tracker_id=68393)](https://www.bountysource.com/trackers/68393-habitrpg?utm_source=68393&utm_medium=shield&utm_campaign=TRACKER_BADGE) [![Dependency Status](https://gemnasium.com/HabitRPG/habitrpg.svg)](https://gemnasium.com/HabitRPG/habitrpg) +Habitica [![Build Status](https://travis-ci.org/HabitRPG/habitrpg.png?branch=develop)](https://travis-ci.org/HabitRPG/habitrpg) [![Code Climate](https://codeclimate.com/github/HabitRPG/habitrpg.png)](https://codeclimate.com/github/HabitRPG/habitrpg) [![Coverage Status](https://coveralls.io/repos/HabitRPG/habitrpg/badge.svg?branch=develop)](https://coveralls.io/r/HabitRPG/habitrpg?branch=develop) [![Bountysource](https://api.bountysource.com/badge/tracker?tracker_id=68393)](https://www.bountysource.com/trackers/68393-habitrpg?utm_source=68393&utm_medium=shield&utm_campaign=TRACKER_BADGE) [![Dependency Status](https://gemnasium.com/HabitRPG/habitrpg.svg)](https://gemnasium.com/HabitRPG/habitrpg) =============== -[HabitRPG](https://habitrpg.com) is an open source habit building program which treats your life like a Role Playing Game. Level up as you succeed, lose HP as you fail, earn money to buy weapons and armor. +[Habitica](https://habitica.com) is an open source habit building program which treats your life like a Role Playing Game. Level up as you succeed, lose HP as you fail, earn money to buy weapons and armor. We need more programmers! Your assistance will be greatly appreciated. -For an introduction to the technologies used and how the software is organised, refer to [Contributing to HabitRPG](http://habitrpg.wikia.com/wiki/Contributing_to_HabitRPG#Coders_.28Web_.26_Mobile.29) - "Coders (Web & Mobile)" section. +For an introduction to the technologies used and how the software is organised, refer to [Contributing to Habitica](http://habitica.wikia.com/wiki/Contributing_to_Habitica#Coders_.28Web_.26_Mobile.29) - "Coders (Web & Mobile)" section. -To set up a local install of HabitRPG for development and testing, see [Setting up HabitRPG locally](http://habitrpg.wikia.com/wiki/Setting_up_HabitRPG_locally), which contains instructions for Windows, *nix / Mac OS, and Vagrant. +To set up a local install of Habitica for development and testing, see [Setting up Habitica Locally](http://habitica.wikia.com/wiki/Setting_up_Habitica_Locally), which contains instructions for Windows, *nix / Mac OS, and Vagrant. -Then read [Guidance for Blacksmiths](http://habitrpg.wikia.com/wiki/Guidance_for_Blacksmiths) for additional instructions and useful tips. +Then read [Guidance for Blacksmiths](http://habitica.wikia.com/wiki/Guidance_for_Blacksmiths) for additional instructions and useful tips. diff --git a/VAGRANT.md b/VAGRANT.md index 91495015a2a..05a9731b366 100644 --- a/VAGRANT.md +++ b/VAGRANT.md @@ -1,11 +1,11 @@ # Vagrant # Vagrant is a system to create reproducible and portable development -environments. Because of the variety of systems used for HabitRPG +environments. Because of the variety of systems used for Habitica development and the various issues developers may encounter setting up -HabitRPG on them, vagrant provides a single development enviroment with +Habitica on them, vagrant provides a single development enviroment with minimal dependencies on the developer's local platform. It can be used on a variety of systems including Windows, Mac OS X, and Linux. -Instructions for using the HabitRPG Vagrant environment are in -[Setting up HabitRPG locally](http://habitrpg.wikia.com/wiki/Setting_up_HabitRPG_locally). +Instructions for using the Habitica Vagrant environment are in +[Setting up Habitica Locally](http://habitica.wikia.com/wiki/Setting_up_Habitica_Locally). diff --git a/common/README.md b/common/README.md index 1528429dc32..9d3e1e2a43b 100644 --- a/common/README.md +++ b/common/README.md @@ -1,6 +1,6 @@ # Common -Shared resources useful for the multiple HabitRPG repositories, that way all the repositories remain in-sync with common characteristics. Includes things like: +Shared resources useful for the multiple Habitica repositories, that way all the repositories remain in-sync with common characteristics. Includes things like: * Assets - sprites, images, etc * CSS - especially, esp. sprite-sheet mapping diff --git a/vagrant.sh b/vagrant.sh index 3a1ea76b0fb..f44bb6e3b0b 100644 --- a/vagrant.sh +++ b/vagrant.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash # -# HabitRPG provisioning script +# Habitica provisioning script # function for autostart function autostart_habitrpg { @@ -24,7 +24,7 @@ function autostart_habitrpg { } # Main provisioning -echo Setting up HabitRPG... +echo Setting up Habitica... echo cd /vagrant >> /home/vagrant/.bashrc # Prevent warnings: "dpkg-preconfigure: unable to re-open stdin ..." @@ -74,7 +74,7 @@ cd /vagrant echo Installing grunt/bower... npm install -g grunt-cli bower phantomjs -echo Installing HabitRPG +echo Installing Habitica npm install --no-bin-link echo Installing Bower packages @@ -84,7 +84,7 @@ sudo -H -u vagrant bower --config.interactive=false install -f ## node ./src/seed.js ## no longer required - see comments in src/seed.js -# Uncomment both lines to autostart the habitrpg server when provisioning -# echo Starting HabitRPG server... +# Uncomment both lines to autostart the habitica server when provisioning +# echo Starting Habitica server... # autostart_habitrpg diff --git a/website/public/front/README.md b/website/public/front/README.md index d379648ea1f..b3d09fa4888 100644 --- a/website/public/front/README.md +++ b/website/public/front/README.md @@ -1,4 +1,4 @@ -New landing page for HabitRPG +New landing page for Habitica ====================== ## (February 2014) @@ -8,4 +8,4 @@ I’ve included a wireframe that shows the interactions I’m looking for. There Thinking of using [ScrollMagic](http://janpaepke.github.io/ScrollMagic/) but if there’s anything anyone else knows and can implement quickly, I’m all ears! -@lefnire suggests [Skrollr](https://github.com/Prinzhorn/skrollr), so that’s another option! \ No newline at end of file +@lefnire suggests [Skrollr](https://github.com/Prinzhorn/skrollr), so that’s another option! diff --git a/website/src/controllers/auth.js b/website/src/controllers/auth.js index fc5e5dafbe4..96d735c0076 100644 --- a/website/src/controllers/auth.js +++ b/website/src/controllers/auth.js @@ -20,7 +20,7 @@ var NO_USER_FOUND = {err: "No user found."}; var NO_SESSION_FOUND = { err: "You must be logged in." }; var accountSuspended = function(uuid){ return { - err: 'Account has been suspended, please contact leslie@habitrpg.com with your UUID ('+uuid+') for assistance.', + err: 'Account has been suspended, please contact leslie@habitica.com with your UUID ('+uuid+') for assistance.', code: 'ACCOUNT_SUSPENDED' }; } @@ -243,9 +243,9 @@ api.resetPassword = function(req, res, next){ user.auth.local.salt = salt; user.auth.local.hashed_password = hashed_password; utils.sendEmail({ - from: "HabitRPG ", + from: "Habitica ", to: email, - subject: "Password Reset for HabitRPG", + subject: "Password Reset for Habitica", text: "Password for " + user.auth.local.username + " has been reset to " + newPassword + ". Log in at " + nconf.get('BASE_URL') + ". After you've logged in, head to "+nconf.get('BASE_URL')+"/#/options/settings/settings and change your password.", html: "Password for " + user.auth.local.username + " has been reset to " + newPassword + ". Log in at " + nconf.get('BASE_URL') + ". After you've logged in, head to "+nconf.get('BASE_URL')+"/#/options/settings/settings and change your password." });