From 28a2b52712a4ab540c0149c5ec30998bb60a51ee Mon Sep 17 00:00:00 2001 From: Pascal Andy Date: Tue, 12 Feb 2019 15:33:34 -0500 Subject: [PATCH] major readme update Signed-off-by: Pascal Andy --- README-tmp.md | 90 ------------------------------- README.md | 143 +++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 142 insertions(+), 91 deletions(-) delete mode 100644 README-tmp.md diff --git a/README-tmp.md b/README-tmp.md deleted file mode 100644 index ebe9816..0000000 --- a/README-tmp.md +++ /dev/null @@ -1,90 +0,0 @@ -# FirePress_Klimax2 - - -## What is this? - -- **FirePress_Klimax2** — It’s a free and responsive Ghost theme (*a template if you prefer*) made for Ghost. -- **Compatibility** — This theme works on Ghost `>= 2.0.0`. -- **What is Ghost?** — Ghost is an open source software that lets you create your website with a blog. See the [FAQ section](https://play-with-ghost.com/ghost-themes/faq/#what-is-ghost) for more details. - - -## Live Demo - -**play-with-ghost.com** is a playground to learn about Ghost. You can **see** Ghost themes and **login** into the admin panel by using the available credentials. In short, you can try Ghost on the spot without having to sign-up! - -- **Live Demo** ==> https://play-with-ghost.com/live-demo-firepress-klimax2-for-barbershops/ -- **Log in credentials** ==> https://play-with-ghost.com/ghost-themes/firepress-klimax2-for-barbershops/ -- **Admin Panel** ==> https://play-with-ghost.com/live-demo-firepress-klimax2-for-barbershops/ghost/ - - -## Why fork this Ghost Theme ? - -- **Enhancements** — This theme has been enhanced to feature some elements that are not present in the original theme. IMHO, these are essential enhancements that are hard to live without: - - **Buttons** (unicorn UI) - - **Icons** (Font Awesome 5) - - **Code Syntax** (highlight.js) - - **Grid** (great to make pricing table) -- **Drop-in replacement** — No special tweaks to do. It will work out of the box. -- **Code Injection** — Take a look those snippets in this [Git repo](https://github.com/firepress-org/Code-Injection-Ghost). It’s an easy way to customize your theme. -- **Curated** — This theme was carefully selected out of hundreds of Ghost Themes. See more of them in our [Ghost-Theme-Curated-Collection ](https://github.com/firepress-org/Ghost-Theme-Curated-Collection/tree/master/01_go) repo, or [by tags on Github](https://github.com/topics/firepress-ghost-theme). - - -## Contributing - -Here’s how I suggest you go about proposing a change to this project: - -1. [Fork this project](https://help.github.com/articles/fork-a-repo/) to your account. -2. [Create a branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) for the change you intend to make (i.e. `git checkout -b my-new-feature`) -3. Commit your changes: `git commit -am 'Add some feature'` -4. Push to the branch: `git push origin my-new-feature` -5. [Submit a pull request](https://help.github.com/articles/about-pull-requests/) from your fork’s branch to our `master` branch. - - Explain why you’re making a change. Even if it seems self-evident, please take a sentence or two to tell us why your change or addition should happen. It’s especially helpful to articulate why this change applies to everyone who works with the applicable technology, rather than just you or your team. - - Please only modify one element per pull request. This helps keep pull requests and feedback focused on a specific project or technology. - - -## Sources & Fork - -- This Git repo is available at https://github.com/firepress-org/FirePress_Klimax2 -- This project was forked from https://github.com/TryGhost/Casper - - -## License - -- This fork is under the **GNU** license. Details at https://github.com/pascalandy/GNU-GENERAL-PUBLIC-LICENSE -- This theme is under the **MIT** license. Details at https://ghost.org/license/ - - -## FirePress Hosting - -At FirePress we do one thing and we do it with our whole heart: we host **fully managed Ghost’s websites**. The idea behind FirePress is to empower freelancers and small organizations to be able to build an outstanding mobile-first website. Start your [free trial here](https://play-with-ghost.com/ghost-themes/free-10-day-trial/). - -We offer **workshops** where participants ends up with a website/blog they can easily operate themselves. Details are coming soon. It is available in those cities: - -- Montréal - Canada -- Québec City - Canada -- Toronto - Canada -- New-York - USA - -Because we believe your website should speak up in your name, we consider our mission completed once your site has become [your impresario](https://play-with-ghost.com/ghost-themes/why-launching-your-next-website-with-firepress/). - - -## Keep in touch - -- Pascal Andy’s [« now page »](https://pascalandy.com/blog/now/) -- Follow me on [Twitter](https://twitter.com/askpascalandy) -- Find more Ghost Themes on [play-with-ghost.com](https://play-with-ghost.com/) - - -## Screenshots - -![firepress_klimax2_10](https://user-images.githubusercontent.com/6694151/45888951-44604b80-bd8d-11e8-9b8a-6fd8dd6052b8.jpg) - -
- -![firepress_klimax2_11](https://user-images.githubusercontent.com/6694151/45888952-44604b80-bd8d-11e8-9845-68627d6dc573.jpg) - -
- -![firepress_klimax2_12](https://user-images.githubusercontent.com/6694151/45889214-d9fbdb00-bd8d-11e8-8c4f-540c03a0d5b1.jpg) - -
\ No newline at end of file diff --git a/README.md b/README.md index 837893e..c14c162 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,145 @@ -# FirePress Klimax2 +  + +

+ + FirePress + +

+ +

+ FirePress.org  |   + play-with-ghost.org  |   + GitHub  |   + Twitter +

+

+ +  + + +# FirePress_Klimax2 ## What is this? + +This theme is a free and responsive theme (*template if you prefer*) made for Ghost. This theme is compatible with Ghost `>= 2.0.0`. You can check this information in the file `package.json`. + +**What is Ghost?** — Ghost is an open source software that lets you create a website and manage content like a blog. [See our FAQ section](https://firepress.org/en/faq/#what-is-ghost) for more details. + +
+ + +## Live Demo + +[play-with-ghost.com](https://play-with-ghost.com/) is a playground to learn about Ghost. What's remarkable here, is that you have the option to log in into the admin panel of each live demo available, by using dummy credentials. + +In short, you can try Ghost on the spot without having to sign-up! + +
+ +[![pwg-video-preview-e](https://user-images.githubusercontent.com/6694151/50233512-9bbc8a80-0381-11e9-83bb-f29a67000378.jpg) +](https://play-with-ghost.com/) + +**Bonus** — The live demo sites feature a post named **Style guide**. It gives you the big picture of how this theme renders elements like titles, quotes, paragraphs, button tables, etc. + +
+ + +## Why fork this Ghost Theme? + +- **Drop-in replacement** — No special tweaks to do. It will work out of the box. +- **Enhancements** — This theme has been enhanced to feature some elements that are not present in the original theme. IMHO, these elements are hard to live without. + - Buttons (three styles) + - Icons (Font Awesome) + - Code Syntax (highlight.js) + - Tables (Grid) (great to make pricing table) +- **Code Injection** — We share snippets that improve the look of this theme via this [Git repo](https://github.com/firepress-org/Code-Injection-Ghost). It’s an easy way to customize this theme. This allows you to override pretty much any styles you want to change. +- **Curated** — This theme was carefully selected out of hundreds of Ghost themes. See more of them in our [Ghost-Theme-Curated-Collection ](https://github.com/firepress-org/Ghost-Theme-Curated-Collection/tree/master/01_go) repo, or [by tags on Github](https://github.com/topics/firepress-ghost-theme). + +⚠️ Warning: Subscribers is a beta feature **not supported** in this theme at present. Likely will be replaced with something new in the near future. [See issue](https://github.com/TryGhost/London/issues/3). +⚠️ Warning: There is a conflict with the custom button. Working on it. + +
+ + +## Screenshots + +![firepress_klimax2_10](https://user-images.githubusercontent.com/6694151/45888951-44604b80-bd8d-11e8-9b8a-6fd8dd6052b8.jpg) + +
+ +![firepress_klimax2_11](https://user-images.githubusercontent.com/6694151/45888952-44604b80-bd8d-11e8-9845-68627d6dc573.jpg) + +
+ +![firepress_klimax2_12](https://user-images.githubusercontent.com/6694151/45889214-d9fbdb00-bd8d-11e8-8c4f-540c03a0d5b1.jpg) + +
+ +## Services + +#### Hosting + +**At FirePress we host Ghost’s websites with an optional landing page**. It's fully managed for you. It means you never have to touch a server, do an upgrade, manage backups or any annoying stuff like this. + +The idea behind FirePress is to empower freelancers and small organizations to be able to build an outstanding mobile-first website. + +Because we believe your website should speak up in your name, we consider our mission completed once your site has become [your impresario](https://firepress.org/en/why-launching-your-next-website-with-firepress/). Start your [free trial here](https://firepress.org/en/10-day-free-trial/). + +#### Workshop + +Participants will end up with a website and/or a blog they can smoothly operate themselves. We are actively working on this workshop. + +The workshops will be available in those cities: + +- Montréal - Canada +- Toronto - Canada +- Québec City - Canada +- New-York - USA +- Boston - USA + +Follow the details [on this page](https://firepress.org/en/workshop/). + +
+ + +## Contributing + +The power of communities pull request and forks means that `1 + 1 = 3`. You can help to make this repo a better one! Here is how: + +1. Fork it +2. Create your feature branch: `git checkout -b my-new-feature` +3. Commit your changes: `git commit -am 'Add some feature'` +4. Push to the branch: `git push origin my-new-feature` +5. Submit a pull request + +Check this post for more details: [Contributing to our Github project](https://pascalandy.com/blog/contributing-to-our-github-project/). Also, by contributing you agree to the [Contributor Code of Conduct on GitHub](https://pascalandy.com/blog/contributor-code-of-conduct-on-github/). It's plain common sense really. + +
+ + +## License + +- This fork is under the **GNU** license. Details at https://github.com/pascalandy/GNU-GENERAL-PUBLIC-LICENSE +- This theme is under the **MIT** license. Details at https://ghost.org/license/ + +
+ + +## Sources & Fork + +- This Git repo is available at https://github.com/firepress-org/FirePress_Klimax2 +- This project was forked from https://github.com/TryGhost/Casper + +
+ + +## Why all this work? + +Our [mission](https://firepress.org/en/our-mission/) is to empower freelancers and small organizations to build an outstanding mobile-first website. + +Because we believe your website should speak up in your name, we consider our mission completed once your site has become your impresario. + +For more info about the man behind the startup, check out my [now page](https://pascalandy.com/blog/now/). You can also follow me on Twitter [@askpascalandy](https://twitter.com/askpascalandy). + +— The FirePress Team 🔥📰