Swift-BigInt icon indicating copy to clipboard operation
Swift-BigInt copied to clipboard

Refactor readme

Open mkrd opened this issue 6 years ago • 4 comments

Let's face it, the readme could be a lot better. It should be refactored to conform to current conventions, provide a more complete overview of the library and to increase readability

mkrd avatar Apr 16 '18 16:04 mkrd

Alternatively / in addition you could make use of the GitHub wiki feature or use Jazzy to automatically create your documentation (similarly to BigInt).

twodayslate avatar Apr 27 '18 00:04 twodayslate

@mkrd can you enable docs as mentioned in #38?

twodayslate avatar Sep 22 '18 00:09 twodayslate

Docs: http://mkrd.github.io/Swift-BigInt/

@mkrd if you could put this in the Website section for the project?

Then I think this can be closed after a ./generate-docs.sh

twodayslate avatar Sep 04 '19 19:09 twodayslate

I can't for the life of me to get jazzy to work after getting a new mac. I think moving to swiftdoc (and the associated GitHub Action) is the best way forward.

twodayslate avatar Aug 20 '20 17:08 twodayslate