Skip to content

added links to dependencies, more detailed instructions #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bakisama wants to merge 2 commits into
base: main
Choose a base branch
from
Open

added links to dependencies, more detailed instructions #13

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1df3410
added links to dependencies, more detailed instructions
bakisama Dec 3, 2023
1dc1fe4
added links to dependencies, more detailed instructions
bakisama Dec 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,35 @@
# keyboards
# <img src="https://raw.githubusercontent.com/JuliaLang/julia/3e4b38684e38a015446253f5752ee9cf840f50cc/contrib/julia.svg" width="32" alt="julia.png"/> keyboards

Supporting simulated annealing code for the [Why I Made The World's Worst Keyboard](https://youtu.be/188fipF-i5I) YouTube video.

Written in Julia... because it's fast, easy to read, and annoys my labmates.

To run, clone the this repository and start Julia with `julia
--project=.` and run `include("keyboardSA.jl")`. It should start by
To run, clone this repository and start Julia with `julia --project=.` and run `include("keyboardSA.jl")`. It should start by
benchmarking your training data (myBook.txt) against QWERTY followed by building
it's own optimal layout. Change the number of iterations and cooling rates as
desired within the SA() function. The terminal will give some indication of
current progres (also stored by a new text file will give a
current progress (also stored by a new text file will give a
iteration-by-iteration record of progress), and .png files of the current best
solution will be saved to your same directory.

To train on your own custom dataset either point the "myBook.txt" somewhere else or just replace its contents.

Good luck!

## more detailed instructions
## Prerequisites

Download at https://julialang.org/downloads/ and install the Julia language.
Make sure you have installed all of the following prerequisites on your development machine:

- Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
- Julia - [Download & Install Julia](https://julialang.org/downloads/#upcoming_release), and install the Julia language(version 1.10.0-rc1). Make sure to check

## Optional

If you want to play with the script, it's recommended to use the
[Revise.jl](https://github.com/timholy/Revise.jl) package to minimize latency.
You can find install instructions [here](https://timholy.github.io/Revise.jl/stable/#Installation)

## Running Application

Assuming `julia` is in your path, run

Expand All @@ -28,6 +38,3 @@ git clone https://github.com/AtomicFrontierCode/keyboards.git
cd keyboards
julia -L 'keyboardSA.jl'
```

If you want to play with the script, it's recommended to use the
[Revise.jl](https://github.com/timholy/Revise.jl) package to minimize latency.