Fred's firmware development diary comments thread

[jharvey]

So does this mean I can change this Mantis tracker item to resolved?

[Fred]

Just assign it back to me and I'll close it when I push the files that resolve it :-)

I'll be committing a doxyfile too with all the unused options removed and relative paths for the directories. It should just be a matter of checking the version and name, running, uploading, zipping, releasing for you then :-)

Fred.

[Fred]

It still needs work, but I pushed it up so you can see what I've done. The doxyfile now lives in the docs directory, and when run from the project directory, it will search the source directory and place docs in a doxygen-html directory inside docs. you can zip that up into a named/versioned zip file easily and keep a local copy for yourself in a good place all at once :-) Likewise, if someone has the code and doxy binaries but no internet, they can create it from scratch themselves. Mint. Thanks for pushing this in the right direction!

I think you should get github/git/ssh setup and fork the main repo so you can make little changes and push them up when you feel like it. If the changes are O for awesome I can pull them back in and we'll have a record that it was you that did it :-)

Fred.

[jharvey]

Well my resistance to git hasn't really been voluntary. It's been caused by ignorance and time. I had started a how to git on the wiki, however, that is currently windows based. So I started a Linux based version, but flopped. I posted my history up there, perhaps you can de-ignorantize me. Here's a link to the wiki instructions.

http://freeems.aaronb.info/wiki/doku.php?id=git-howto

[Fred]

Your first issue is that you used these 'a' instead of these `b`, the former are just quotes for escaping text from the shell, the latter executes whatever is inside it, and eval doesn't care about what you pass in. eval is just a way of saying "don't run this here" or similar.

Fix that on the wiki (my stuff above yours has it correct) and on your pc and let me know what the next hurdle is. I had it setup on windows fairly quickly. I'd have documented it better, but i closed the window accidentally before i could copy/paste...

Fred.

[jharvey]

Alright, I've hit the next road block. Now I need to know how to setup git, and do a checkout. I've updated the wiki, so you can see how far along I've made it.

[Fred]

ok, 2 things

1) although you said configure github username, you didn't appear to do it. If you did, sweet, just add it to the wiki, if not, do it :-)
2) you should not have done git init. put that in bold as a warning that you don't create anything locally first. once you are all setup, grabbing a new repo should be a two step process :

a) click fork on the site
b) clone the private url

definitely not git init.

just deleting the directory you inited is sufficient.

when you clone you do :

git clone <private clone url> <dir to create>

Good luck, and may the fork be with you :-)

Fred.

[jharvey]

1) although you said configure github username, you didn't appear to do it. If you did, sweet, just add it to the wiki, if not, do it

Um... Not sure here. Is that this series of commands?

$ git config --global user.name "username"
$ git config --global user.email email@email.com
$ git config --global github.token 112233445566778899aabbccddeeff11
$

If that's not it, perhaps you can fill me in more. I honestly don't know what configure github means. Perhaps that's at the web page?

2) you should not have done git init. put that in bold as a warning that you don't create anything locally first. once you are all setup, grabbing a new repo should be a two step process :

a) click fork on the site
b) clone the private url

I removed git init from the wiki and deleted the local .git folder.

I added more to the wiki, hopefully it's kind of in sequence. I may have missed a step or two, and I certainly didn't follow those steps exactly the way they are posted up there, but I think they are right for a new comer.

I seem to recall the firmware is up there, but I don't know where to find it. When I search for FreeEMS I only get the tuner. A quick look doesn't seem to show it under this repo, where might I find the firmware repo?

when you clone you do :

git clone <private clone url> <dir to create>

Good luck, and may the fork be with you

Appears I've got it now, and with luck I've documented the process in such a manner that I've removed stumbling block for others that come along.

[Fred]

Um... Not sure here. Is that this series of commands?

$ git config --global user.name "username"
$ git config --global user.email email@email.com
$ git config --global github.token 112233445566778899aabbccddeeff11
$

Yep, thats the one, make it look like this :

$ git config --global user.name "username"
$ git config --global user.email email@email.com
$ git config --global github.token 112233445566778899aabbccddeeff11
$ git config --global github.username "username"

By adding this :

$ git config --global github.username "username"

I added more to the wiki, hopefully it's kind of in sequence. I may have missed a step or two, and I certainly didn't follow those steps exactly the way they are posted up there, but I think they are right for a new comer.

It's better, and improving, but still not right.

The click fork stuff is great, but the clone stuff is wrong.

For you, it should be something like this :

Code: Select all

git clone git@github.com:jharvey/freeems-vanilla.git freeems-vanilla

or

Code: Select all

git clone git@github.com:jharvey/freeems-tuner.git freeems-vanilla

the data you get is the same, so you could just manipulate the git config afterwards, but this is the correct approach, NOT taking a clone of Aaron's or Mine directly, not if you want it to be easy to just push anyway.

I seem to recall the firmware is up there, but I don't know where to find it. When I search for FreeEMS I only get the tuner.

Yes, this is a problem, I think I may need to tag it or something?

A quick look doesn't seem to show it under this repo, where might I find the firmware repo?

http://github.com/fredcooke/freeems-vanilla/tree/master

Appears I've got it now, and with luck I've documented the process in such a manner that I've removed stumbling block for others that come along.

Nearly there, keep at it and we'll have it perfect :-)

Fred.

[jharvey]

More updates to the wiki. Perhaps the next one to come along can iron out more bumps, but I think it's likely very close to right now.