Hacktoolkit is the ONE open source project to rule them all (we try to, at least).
The spirit of this project is summarized in this tagline: Win hackathons by using refined APIs and bootstrap code to build complete websites and apps in 24 hours.
README is about the hacktoolkit library hosted at: https://github.com/hacktoolkit/hacktoolkit
For information about the project, see the website: http://hacktoolkit.com
- Code is organized into sub-folders or submodules, each with their own
- Always read the
READMEfiles in subdirectories before using the code so that your computer or mobile device doesn't blow up.
Goals and Philosophy
- There will only be one main repository, ever, for Hacktoolkit (with the exception of submodules--more on this later)
- The goal is to be one repository that users can clone and immediately start using, not 47 different repositories.
- Easy to use; easy onboarding process
- Clean, robust code
- Find the best examples that are already existing (don't reinvent the wheel), and import them as submodules
- We love skeletons and bootstrap code
Hacktoolkit vs hacktoolkit
Use Hacktoolkit (capital, proper name, one word, no spaces or hyphens) when referring to the project or code.
hacktoolkit (all lowercase) only when referring to the code, library, or package name.
Names in code
- Java or Android package names, for example, should start with
htkis the preferred abbreviation for lowercase names
- Java class names can use the prefix
Three simple steps:
- Clone the repository
git clone firstname.lastname@example.org:hacktoolkit/hacktoolkit.git
- Update submodules
git submodule init(inside the directory of the newly cloned repository; only run the first time)
git submodule update(Download the submodule codes the first time)
Start coding away with Hacktoolkit and share your delight with everyone else.
To get future updates, run:
git pull && git submodule update
This project makes extensive use of Git Submodules.
For information on how to use Git Submodules, read http://git-scm.com/book/en/Git-Tools-Submodules.
In addition to the normal
git clone or
git pull, two commands are necessary to keep the submodules up-to-date:
git submodule initafter cloning
git submodule updateupdates all the submodules
Hacktoolkit is always looking for help, whether you are a designer or a developer. If you would like to be a maintainer for Hacktoolkit, contact Jonathan Tsai (https://github.com/jontsai). The majority of people should probably just fork this repository and issue pull requests.
- Always include a
.mdis preferred) file in each directory, unless it is a leaf
- Follow the best practices and coding style guides for that language, platform, or API
- Use your best judgment and common sense, always.
- More coming...