Skip to content

Commit f235263

Browse files
committed
git rebase
1 parent fbfc7a1 commit f235263

File tree

6 files changed

+0
-2347
lines changed

6 files changed

+0
-2347
lines changed

LICENSE

-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
MIT License
22

3-
<<<<<<< HEAD
4-
Copyright (c) 2019 Chris Pearson
5-
=======
63
Copyright (c) 2019 kparc
7-
>>>>>>> added license
84

95
Permission is hereby granted, free of charge, to any person obtaining a copy
106
of this software and associated documentation files (the "Software"), to deal

README.md

-34
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,3 @@
1-
<<<<<<< HEAD
2-
# k reference card
3-
4-
https://kparc.github.io/ref
5-
6-
An unofficial clickable version of the k help, accessible in the REPL with `\h`.
7-
8-
It provides examples, short recipes, dev progress notes, and links to other resources.
9-
10-
Trial versions of k for macOS and Linux can be downloaded from Anaconda - follow the instructions [here](https://github.com/kparc/kcc/blob/master/README.md#get).
11-
12-
To add a section:
13-
14-
1. Select a word that you'd like to contribute docs for in the quickref
15-
2. Add it to the `links` array in `index.html`
16-
3. Search for the string 'template' in `index.html`, and copy it. Add the word as an id to the `h2` or `h3` or `h4` and fill in content beneath it.
17-
18-
Edit the docs by editing `index.html`.
19-
20-
TODO:
21-
22-
* Write more docs
23-
* Convert to markdown, implement code validation vs. latest release
24-
* Figure out how to sync `index.html` with changes to the quickref (may need Shakti's help)
25-
* Tempted to switch to [MkDocs/Material](https://squidfunk.github.io/mkdocs-material/), but want to keep it simple for now
26-
* Consider [Zig's docs approach](https://ziglang.org/documentation/master/#Introduction) - easily downloaded single file + code samples form part of the test suite
27-
* Get a better system for dynamically adding links, that can handle a word appearing more than once in the help (eg maybe subsequent mentions become '#list2')
28-
* Consider moving 'contribute' link to right-hand side of banner (just be wary of impact on small mobile phone screens)
29-
=======
301
## Yet another take on the refcard
312

323
### Features
@@ -54,10 +25,5 @@ and serve the `./build/` directory over http
5425
* merge with updated content
5526
* plug in test script
5627
* create a build hook
57-
<<<<<<< HEAD
58-
59-
>>>>>>> initial commit
60-
=======
6128
* add some fancy `<meta>` tags like `name` and `description`
6229
* learn [pug](https://naltatis.github.io/jade-syntax-docs/), aka jade, it will take you ~30 minutes, if you want to modify html
63-
>>>>>>> updated README

index.html

-278
This file was deleted.

0 commit comments

Comments
 (0)