Skip to content

Commit 59cdb55

Browse files
committed
[skip] Added standard “Development” section to README with link to ECMA-376 (1m)
1 parent 260b395 commit 59cdb55

3 files changed

Lines changed: 51 additions & 7 deletions

File tree

README.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,31 @@ document.document << paragraph
2323
document.save("/path/where/i/save/things/test.docx")
2424
```
2525

26+
2627
## Installation
2728

28-
You can install OpenXml::Docx by running `gem install openxml-docx`, or if you like Rails, include `gem "openxml-docx"` in your Gemfile.
29+
Add this line to your application's Gemfile:
30+
31+
```ruby
32+
gem 'openxml-docx'
33+
```
34+
35+
And then execute:
36+
37+
$ bundle
38+
39+
Or install it yourself as:
40+
41+
$ gem install openxml-docx
42+
2943

3044
## Current features
3145

3246
- Paragraphs
3347
- Runs and text
3448
- Formatting and styles for the paragraphs, runs, and text
3549

50+
3651
## Roadmap
3752

3853
It's important to note that lists goes off into the future quite a bit, therefore it's very likely that it will change. That being said, this is the plan for future releases:
@@ -52,14 +67,21 @@ It's important to note that lists goes off into the future quite a bit, therefor
5267
- 0.19.0: Mail merge
5368
- 0.20.0: Layer on a DSL for making the whole thing smoother
5469

55-
## Contribute!
5670

57-
Want to help? Thanks, friend! Here's how:
5871

59-
1. Fork it
60-
2. Make your changes on a topic branch
61-
3. Create new a pull request
62-
4. Receive many thank-yous
72+
## Development
73+
74+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
75+
76+
Reference for WordprocessingML can be found in Part 1 of the Fourth Edition of [ECMA-376](http://www.ecma-international.org/publications/standards/Ecma-376.htm) (the Office Open XML Standard).
77+
78+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
79+
80+
81+
## Contributing
82+
83+
Bug reports and pull requests are welcome on GitHub at https://github.com/openxml/openxml-docx.
84+
6385

6486
## Changelog
6587

bin/console

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#!/usr/bin/env ruby
2+
3+
require "bundler/setup"
4+
require "openxml/docx"
5+
6+
# You can add fixtures and/or initialization code here to make experimenting
7+
# with your gem easier. You can also use a different console, if you like.
8+
9+
# (If you use this, don't forget to add pry to your Gemfile!)
10+
# require "pry"
11+
# Pry.start
12+
13+
require "irb"
14+
IRB.start

bin/setup

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#!/usr/bin/env bash
2+
set -euo pipefail
3+
IFS=$'\n\t'
4+
set -vx
5+
6+
bundle install
7+
8+
# Do any other automated setup that you need to do here

0 commit comments

Comments
 (0)