Skip to content

Commit

Permalink
Remove legacy phar file build and update composer tooling (#63)
Browse files Browse the repository at this point in the history
Simplify the build tooling:
* Remove phar build, update tooling to composer
* Remove legacy version tagging system
* Fix incorrect readme generation
  • Loading branch information
craig-davis authored Oct 19, 2017
1 parent b687052 commit 1686262
Show file tree
Hide file tree
Showing 14 changed files with 230 additions and 1,019 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ install:
- travis_retry composer install --prefer-source --no-interaction --dev

script:
- ./vendor/bin/pake test
- composer test
48 changes: 21 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ at the [blog post for the project][blog].
* You can now version control and branch your resume.

## Install

#### OSX

The simplest installation of the requirements is via [Homebrew Cask](https://caskroom.github.io/)
```bash
brew cask install wkhtmltopdf
```

#### Debian
```bash
sudo apt install php7.0-mbstring wkhtmltopdf
Expand All @@ -27,16 +35,14 @@ sudo dnf install php-mbstring wkhtmltopdf

## Quickstart

There is no installation or need to run composer. Just download and [run the phar file](https://github.com/there4/markdown-resume/raw/master/bin/md2resume):

```
./bin/md2resume html examples/source/sample.md examples/output/
./bin/md2resume pdf examples/source/sample.md examples/output/
```

## Help
```
Markdown Resume Generator version 2.0.10 by Craig Davis
Markdown Resume Generator version 2.1.0 by Craig Davis
Usage:
[options] command [arguments]
Expand All @@ -51,14 +57,13 @@ Options:
--no-interaction -n Do not ask any interactive question.
Available commands:
help Displays help for a command
html Generate an HTML resume from a markdown file
list Lists commands
pdf Generate a PDF from a markdown file
selfupdate Updates md2resume.phar to the latest version.
stats Generate a word frequency analysis of your resume
templates List available templates
version Show current version information
help Displays help for a command
html Generate an HTML resume from a markdown file
list Lists commands
pdf Generate a PDF from a markdown file
stats Generate a word frequency analysis of your resume
templates List available templates
version Show current version information
```
## Examples
Expand Down Expand Up @@ -89,32 +94,19 @@ and then use CSS rules to display a nicely formatted resume. Note that because
we have very few ways to nest or identify elements that many of the css rules
are based on descendant and adjacent selectors.

__PLEASE NOTE__: The templates are compiled into the phar archive in the `./bin`
folder. If you intend to edit the templates or add new ones, you'll need to run
this application in the dev mode. See below for more information about doing
this.

## Feature Development

The application is deployed as a compiled phar file. In order to add new
commands, you'll need to first install the dependencies:
In order to add new commands, you'll need to first install the dependencies:

* `composer install`

After that, you can run the `md2resume_dev.php` file from the command line.

## Building a Release

1. Tag the repo with the new build number. This will be picked up for both
the `version` file used by the self update command and placed into the
phar file.
2. Run `pake build`.
1. Tag the repo with the new build number.
2. Run `composer build`.
3. Push both the tag and the code.

Check out the pake tooling for more information about the build. Pake will be
installed to `./vendor/bin/pake`. So for instance a complete phar file build
looks like `./vendor/bin/pake build`.

## Acknowledgments

The initial inspiration is from the [Sample Resume Template][srt].
Expand All @@ -124,6 +116,7 @@ are a more comfortable with html than markdown, you should use it.

## Changelog

* __2.2.0__ : Dropped phar file distribution, removed Pake and migrated to composer commands
* __2.1.0__ : Dropped PHP5 support
* __2.0.12__ : Added new `Roboto` template from [@ejwaibel](https://github.com/ejwaibel)
* __2.0.10__ : Updated spacing in moder template with commites from [@501st-alpha1](https://github.com/501st-alpha1)
Expand Down Expand Up @@ -157,3 +150,4 @@ are a more comfortable with html than markdown, you should use it.
[pake]: https://github.com/indeyets/pake/wiki/Installing-Pake
[wkhtmltopdf]: https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF
[console]: http://symfony.com/doc/current/components/console/introduction.html
HELLO
Binary file modified bin/md2resume
Binary file not shown.
Loading

0 comments on commit 1686262

Please sign in to comment.