Re: Documentation [was: Re: v8 DP3]

[Mark Wieder]

Charles Warwick  writes:

> However, you can also install a plugin called “Git Plus” that allows you to 
use keyboard shortcuts to
> add/commit/push etc…

Thanks - wasn't aware of that one.

-- 
 Mark Wieder
 ahsoftw...@gmail.com
___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Charles Warwick]

> On 31 Aug 2015, at 3:45 pm, Mark Wieder  wrote:
> 
> On 08/28/2015 02:32 AM, Richmond wrote:
>> Or, put another way; will Atom work as a Git GUI?
>> 
>> I am downloading a selection of Linux Git GUIs which all look far more
>> primitive than Atom . . .
> 
> Not sure what you mean by 'Git GUI'...
> 
> If you want to use  as a text editor for gui, then by all 
> means do so. If you also want to use that for git commit messages, etc, then
> 
> git config --global core.editor YourEditorHere
> 
> will make that the default editor.
> 
> If you want a gui to work with git... um... I'm not sure what to suggest. If 
> you want something like gitk then you should probably use gitk (or gitx on 
> osx, or tig). Atom's a text editor. Or at least that's all I've ever used it 
> for. Maybe there's more there.
> 

Atom comes with a default plugin that recognises local git repositories.  So if 
you open the root folder of the git repository as a project folder, it will 
highlight which files have been modified since the last commit along with 
giving you a few other details like the branch you are on and whether you are 
behind on any commits.

However, you can also install a plugin called “Git Plus” that allows you to use 
keyboard shortcuts to add/commit/push etc…

I have only tried that plugin once or twice as I prefer to use SourceTree under 
os x to deal with git.  I do find the standard features of Atom like which 
files have been modified since your last commit handy though.

Cheers,

Charles


> -- 
> Mark Wieder
> ahsoftw...@gmail.com
> 
> ___
> use-livecode mailing list
> use-livecode@lists.runrev.com
> Please visit this url to subscribe, unsubscribe and manage your subscription 
> preferences:
> http://lists.runrev.com/mailman/listinfo/use-livecode
> 


___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Mark Wieder]

On 08/28/2015 02:32 AM, Richmond wrote:

Or, put another way; will Atom work as a Git GUI?

I am downloading a selection of Linux Git GUIs which all look far more
primitive than Atom . . .


Not sure what you mean by 'Git GUI'...

If you want to use YourEditorHere as a text editor for gui, then by 
all means do so. If you also want to use that for git commit messages, 
etc, then


git config --global core.editor YourEditorHere

will make that the default editor.

If you want a gui to work with git... um... I'm not sure what to 
suggest. If you want something like gitk then you should probably use 
gitk (or gitx on osx, or tig). Atom's a text editor. Or at least that's 
all I've ever used it for. Maybe there's more there.


--
 Mark Wieder
 ahsoftw...@gmail.com

___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Peter TB Brett]

On 2015-08-28 10:28, Richmond wrote:


https://help.github.com/articles/which-remote-url-should-i-use/#cloning-with-https-recommended

When you view a repository while signed in to your account

First of all, where do I find the GIT interface on my computer so that
I can log into it, or,

for the sake of argument, how can I log into the GitHub using Atom
(which I installed just before breakfast),
clone stuff and get to work?


Technically, you don't actually need to install anything on your 
computer to make changes to the documentation.  You can actually do it 
all through the GitHub website!  Ali posted some instructions here: 
http://quality.runrev.com/show_bug.cgi?id=15347#c5


 Peter

--
Dr Peter Brett peter.br...@livecode.com
LiveCode Open Source Team

LiveCode on reddit! https://reddit.com/r/livecode


___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Richmond]

On 08/29/2015 10:04 AM, Peter TB Brett wrote:

On 2015-08-28 10:28, Richmond wrote:


https://help.github.com/articles/which-remote-url-should-i-use/#cloning-with-https-recommended 



When you view a repository while signed in to your account

First of all, where do I find the GIT interface on my computer so that
I can log into it, or,

for the sake of argument, how can I log into the GitHub using Atom
(which I installed just before breakfast),
clone stuff and get to work?


Technically, you don't actually need to install anything on your 
computer to make changes to the documentation.  You can actually do it 
all through the GitHub website!  Ali posted some instructions here: 
http://quality.runrev.com/show_bug.cgi?id=15347#c5


 Peter



That does look a whole lot simpler.

Thank you very much.


Richmond.

___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Richmond]

On 08/28/2015 09:27 AM, Peter TB Brett wrote:

On 2015-08-28 08:20, Richmond wrote:

On 08/27/2015 11:39 PM, J. Landman Gay wrote:

On 8/27/2015 2:33 PM, Peter TB Brett wrote:

Since it's so desperately in need of improvement, and you have such a
good idea of how it can be made better, perhaps you could help out?


I love UK understatement. As one of those rude Americans I would 
have said, Okay Richmond, put your money where your mouth is, or 
maybe, put up or shut up.


We're such an...assertive...culture.



Indeed you are! But I'm also an assertive sort of chap, so I will say:

Yes! I will edit those bits that I feel are lacking, and work on the
assumption that others will be
doing the same!


Awesome.  Community contributions to the open source package are 
always really welcome.


I'll do what I can to work with you and ensure that documentation 
changes get incorporated quickly and efficiently.


   Peter



Well: as an almost complete moron in certain respects, I would be 
grateful if you could outline a way to edit
the documents at 
https://github.com/runrev/livecode-ide/tree/develop/Documentation/guides 
and submit them after

the editing . . . does this involve setting up my own github branch

Richmond.

___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Peter TB Brett]

On 2015-08-28 08:20, Richmond wrote:

On 08/27/2015 11:39 PM, J. Landman Gay wrote:

On 8/27/2015 2:33 PM, Peter TB Brett wrote:

Since it's so desperately in need of improvement, and you have such a
good idea of how it can be made better, perhaps you could help out?


I love UK understatement. As one of those rude Americans I would have 
said, Okay Richmond, put your money where your mouth is, or maybe, 
put up or shut up.


We're such an...assertive...culture.



Indeed you are! But I'm also an assertive sort of chap, so I will say:

Yes! I will edit those bits that I feel are lacking, and work on the
assumption that others will be
doing the same!


Awesome.  Community contributions to the open source package are always 
really welcome.


I'll do what I can to work with you and ensure that documentation 
changes get incorporated quickly and efficiently.


   Peter

--
Dr Peter Brett peter.br...@livecode.com
LiveCode Engine Development Team

LiveCode on reddit! https://reddit.com/r/livecode

___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Peter W A Wood]

 On 28 Aug 2015, at 15:15, Richmond richmondmathew...@gmail.com wrote:
 
 Well: as an almost complete newcomer to Github, I would be grateful if you 
 could outline a way to edit
 the documents at 
 https://github.com/runrev/livecode-ide/tree/develop/Documentation/guides 
 https://github.com/runrev/livecode-ide/tree/develop/Documentation/guides 
 and submit them after
 the editing . . . does this involve setting up my own github branch

Yes. You will need a Github account and then fork the Github repository. You 
can then edit the documents on-line. Once you have finished editing the 
documents, you will need to create a Pull Request. The LiveCode team will then 
decide whether to accept or decline your changes.

One thing that is needed for your changes to be accepted is to for you to enter 
into a contributor’s agreement http://livecode.com/account/developer/contribute 
http://livecode.com/account/developer/contribute

You can make better use of Git by downloading the repository onto your own 
machine. I was able to do that quite easily by following this 
https://help.github.com/categories/bootcamp/ 
https://help.github.com/categories/bootcamp/

I have no doubt that you will breeze though the process.

Peter

___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Richmond]

On 08/27/2015 11:39 PM, J. Landman Gay wrote:

On 8/27/2015 2:33 PM, Peter TB Brett wrote:

Since it's so desperately in need of improvement, and you have such a
good idea of how it can be made better, perhaps you could help out?


I love UK understatement. As one of those rude Americans I would have 
said, Okay Richmond, put your money where your mouth is, or maybe, 
put up or shut up.


We're such an...assertive...culture.



Indeed you are! But I'm also an assertive sort of chap, so I will say:

Yes! I will edit those bits that I feel are lacking, and work on the 
assumption that others will be

doing the same!

Richmond.

___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Richmond]

On 08/28/2015 12:28 PM, Richmond wrote:

On 08/28/2015 12:21 PM, Peter TB Brett wrote:



On 28/08/2015 10:11, Richmond wrote:

On 08/28/2015 10:28 AM, Peter W A Wood wrote:


You can make better use of Git by downloading the repository onto your
own machine. I was able to do that quite easily by following this
https://help.github.com/categories/bootcamp/
https://help.github.com/categories/bootcamp/

I have no doubt that you will breeze though the process.


I very much doubt it: I downloaded GIT,

told GIT my name ('richmond'),

told GIT my email ('richmondmathew...@gmail.com'),

and then got stuck:

https://help.github.com/articles/set-up-git/#next-steps-authenticating-with-github-from-git 




so; where is GIT


Exactly which step are you stuck on?

 Peter

https://help.github.com/articles/which-remote-url-should-i-use/#cloning-with-https-recommended 



When you view a repository while signed in to your account

First of all, where do I find the GIT interface on my computer so that 
I can log into it, or,


for the sake of argument, how can I log into the GitHub using Atom 
(which I installed just before breakfast),

clone stuff and get to work?

Richmond.


Or, put another way; will Atom work as a Git GUI?

I am downloading a selection of Linux Git GUIs which all look far more 
primitive than Atom . . .



___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Richmond]

On 08/28/2015 12:21 PM, Peter TB Brett wrote:



On 28/08/2015 10:11, Richmond wrote:

On 08/28/2015 10:28 AM, Peter W A Wood wrote:


You can make better use of Git by downloading the repository onto your
own machine. I was able to do that quite easily by following this
https://help.github.com/categories/bootcamp/
https://help.github.com/categories/bootcamp/

I have no doubt that you will breeze though the process.


I very much doubt it: I downloaded GIT,

told GIT my name ('richmond'),

told GIT my email ('richmondmathew...@gmail.com'),

and then got stuck:

https://help.github.com/articles/set-up-git/#next-steps-authenticating-with-github-from-git 




so; where is GIT


Exactly which step are you stuck on?

 Peter


https://help.github.com/articles/which-remote-url-should-i-use/#cloning-with-https-recommended

When you view a repository while signed in to your account

First of all, where do I find the GIT interface on my computer so that I 
can log into it, or,


for the sake of argument, how can I log into the GitHub using Atom 
(which I installed just before breakfast),

clone stuff and get to work?

Richmond.

___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Peter TB Brett]

On 28/08/2015 10:11, Richmond wrote:

On 08/28/2015 10:28 AM, Peter W A Wood wrote:


You can make better use of Git by downloading the repository onto your
own machine. I was able to do that quite easily by following this
https://help.github.com/categories/bootcamp/
https://help.github.com/categories/bootcamp/

I have no doubt that you will breeze though the process.


I very much doubt it: I downloaded GIT,

told GIT my name ('richmond'),

told GIT my email ('richmondmathew...@gmail.com'),

and then got stuck:

https://help.github.com/articles/set-up-git/#next-steps-authenticating-with-github-from-git


so; where is GIT


Exactly which step are you stuck on?

 Peter

--
Dr Peter Brett peter.br...@livecode.com
LiveCode Engine Development Team

LiveCode on reddit: https://reddit.com/r/livecode

___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Richmond]

On 08/28/2015 10:28 AM, Peter W A Wood wrote:

On 28 Aug 2015, at 15:15, Richmond richmondmathew...@gmail.com wrote:

Well: as an almost complete newcomer to Github, I would be grateful if you 
could outline a way to edit
the documents at 
https://github.com/runrev/livecode-ide/tree/develop/Documentation/guides 
https://github.com/runrev/livecode-ide/tree/develop/Documentation/guides and 
submit them after
the editing . . . does this involve setting up my own github branch

Yes. You will need a Github account and then fork the Github repository. You 
can then edit the documents on-line. Once you have finished editing the 
documents, you will need to create a Pull Request. The LiveCode team will then 
decide whether to accept or decline your changes.

One thing that is needed for your changes to be accepted is to for you to enter into 
a contributor’s agreement http://livecode.com/account/developer/contribute 
http://livecode.com/account/developer/contribute

You can make better use of Git by downloading the repository onto your own machine. I 
was able to do that quite easily by following this 
https://help.github.com/categories/bootcamp/ 
https://help.github.com/categories/bootcamp/

I have no doubt that you will breeze though the process.


I very much doubt it: I downloaded GIT,

told GIT my name ('richmond'),

told GIT my email ('richmondmathew...@gmail.com'),

and then got stuck:

https://help.github.com/articles/set-up-git/#next-steps-authenticating-with-github-from-git

so; where is GIT

Richmond.


Peter

___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode



___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3

[Ali Lloyd]

Hi James,
The format is indeed not straight markdown but more like YAML. The
Description element is the only part of it which is straight markdown.

You can find a complete description of the format in the Extending Livecode
guide in the dictionary, in the Specifications section.

On Fri, Aug 28, 2015 at 3:02 PM James Hale ja...@thehales.id.au wrote:

 I too was interested in helping with the documentation but am a tad
 confused about its format.
 It is not quite straight markdown, at least as far as any markdown editors
 I have put it through.
 Also I had a look at the viewer.html and was blown away at how complicated
 it was.
 Not that we need to deal with it, but given that it doesn't quite seem to
 be able to translate the markdown of the documentation fully perhaps we
 need more info on the required formatting.
 As an example have a look at what it does to the htmltext entry. Things
 are fine until halfway through it and then things go awry.

 BTW the JavaScript for the dictionary uses a hover function for the found
 entries. Lovely effect on a desktop, disaster on a touch device. Surely I
 am not the only one who likes to use a touch device to read the web, and
 yes, the documentation.

 James



 ___
 use-livecode mailing list
 use-livecode@lists.runrev.com
 Please visit this url to subscribe, unsubscribe and manage your
 subscription preferences:
 http://lists.runrev.com/mailman/listinfo/use-livecode

___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[Peter TB Brett]

On 2015-08-27 08:12, Richmond wrote:

On 08/27/2015 09:59 AM, Charles Warwick wrote:
/I thought I'd just open up my text file using my //*external text 
editor*//(at which point one //

// starts to wonder what the point of the Builder is)/

Both of those require questions, and at the risk of being a bore, 
I'll reiterate them:


1. Why should there be recourse to an external text editor

2.  What is the point of the Builder if one cannot type code into 
it


LCB code needs to be “compiled”, that is the purpose of the builder as 
per Peter’s comment:


The Extension Builder tool is used for compiling and packaging 
extensions.




Aha.

Well then the Documentation is awful as it makes none of these things 
clear.


Hi Richmond,

The documentation is just as free and open source as the rest of the 
LiveCode IDE.  You can find it in our git repository here:


https://github.com/runrev/livecode-ide/tree/develop/Documentation/guides

Since it's so desperately in need of improvement, and you have such a 
good idea of how it can be made better, perhaps you could help out?  
When you've already got a detailed knowledge of a topic, it's often very 
difficult to explain it in a way that's accessible to people who are new 
to it.  Having fresh eyes is often enormously helpful in improving the 
quality and structure of introductory materials!


Please let me know how I can help you get set up for using GitHub and 
making LiveCode better.  There's a brief guide to our workflow here: 
https://github.com/runrev/livecode/blob/develop/HACKING.md#using-github 
(but this, too, could probably benefit with some fleshing-out).


   Peter

--
Dr Peter Brett peter.br...@livecode.com
LiveCode Engine Development Team

LiveCode on reddit! https://reddit.com/r/livecode

___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Re: Documentation [was: Re: v8 DP3]

[J. Landman Gay]

On 8/27/2015 2:33 PM, Peter TB Brett wrote:

Since it's so desperately in need of improvement, and you have such a
good idea of how it can be made better, perhaps you could help out?


I love UK understatement. As one of those rude Americans I would have 
said, Okay Richmond, put your money where your mouth is, or maybe, 
put up or shut up.


We're such an...assertive...culture.

--
Jacqueline Landman Gay | jac...@hyperactivesw.com
HyperActive Software   | http://www.hyperactivesw.com

___
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode