search

Autodesk-AutoCAD / AutoLispExt

Visual Studio Code Extension for AutoCAD® AutoLISP
https://marketplace.visualstudio.com/items?itemName=Autodesk.autolispext
Apache License 2.0
85 stars 29 forks source link

Update README.md to append a translation in Simplified Chinese #172

Closed Higurashi-kagome closed 2 years ago

Higurashi-kagome commented 2 years ago

Just added the README-zh-cn.md——a translation file of Chinese.

Sen-real commented 2 years ago

Hello @Higurashi-kagome, to get your PR merged, please sign the following file (it's once only), and send it to lan.dong@autodesk.com. Thanks a lot! https://github.com/Autodesk-AutoCAD/AutoLispExt/blob/main/Autodesk_Form_Ind_Contrib_Agmt_for_Open_%20Source.pdf

Higurashi-kagome commented 2 years ago

Done. @Sen-real

Higurashi-kagome commented 2 years ago

Thanks for your detailed and professional suggestions. @Sen-real

Sen-real commented 2 years ago

Thanks for your detailed and professional suggestions. @Sen-real

Welcome. Just to double check with you: when viewing source code in VS Code, the links to readme.md and readme-zh-cn.md jump to each other well. But after making and installing a real .vsix in VS Code, clicking the link will open a browser and navigate to github.

E.g. if I click the link to readme-zh-cn.md, the browser opens and navigates to https://github.com/Autodesk-AutoCAD/AutoLispExt/blob/main/README-zh-cn.md (this URL doesn't exist because this PR is not merged yet).

Is this the expected behavior?

Higurashi-kagome commented 2 years ago

It's the expected behavior for me. The link will work fine I guess, just like we click the link to NOTICE.md, the browser opens and navigates to HEAD/NOTICE.md.

Sen-real commented 2 years ago

It's the expected behavior for me. The link will work fine I guess, just like we click the link to NOTICE.md, the browser opens and navigates to HEAD/NOTICE.md.

@Higurashi-kagome We had a discussion on this. Could you please just append the Chinese translation into the same READEM.md?

Higurashi-kagome commented 2 years ago

It's the expected behavior for me. The link will work fine I guess, just like we click the link to NOTICE.md, the browser opens and navigates to HEAD/NOTICE.md.

@Higurashi-kagome We had a discussion on this. Could you please just append the Chinese translation into the same READEM.md?

Updated. The current links can't jump to each other in VSCode but work fine on GitHub, so, I guess, it will also work just like what we want on the Visual Studio Marketplace.

Sen-real commented 2 years ago

It's the expected behavior for me. The link will work fine I guess, just like we click the link to NOTICE.md, the browser opens and navigates to HEAD/NOTICE.md.

@Higurashi-kagome We had a discussion on this. Could you please just append the Chinese translation into the same READEM.md?

Updated. The current links can't jump to each other in VSCode but work fine on GitHub, so, I guess, it will also work just like what we want on the Visual Studio Marketplace.

Hi @Higurashi-kagome, I tried your latest code, and the links couldn't jump to each other. I think VS Code does have this capability, and the links can't jump simply because the link ids are wrong.

E.g. I locally added two headers for testing purpose: Screenshot 2021-11-26 at 4 54 26 PM Screenshot 2021-11-26 at 4 54 58 PM

I then:

They did jump as expected - they didn't navigate to github or open a browser; they just jumped inside VS Code.

You could build the extension on your own and have a try. Here're the steps: https://github.com/Autodesk-AutoCAD/AutoLispExt/blob/main/DevREADME.md#how-to-setup-the-dev-env-and-compile-the-code

After the 3rd step (python pack.py) is done, if there's nothing wrong you will see following messages: image

Then you'll get an "autolispext.vsix" in the root folder of source code. It can be manually installed via. the Extensions panel: image

Higurashi-kagome commented 2 years ago

Updated and tested. Works fine on my machine. It would be good if you can also test it. @Sen-real

By the way, the links can't work as expected on the GitHub readme page now. This might be fixed by adding some code in pack.py. For example, make sure the links work well on GitHub firstly, and before generating the .vsix file, change the link and recover it after generating.

Sen-real commented 2 years ago

Updated and tested. Works fine on my machine. It would be good if you can also test it. @Sen-real

By the way, the links can't work as expected on the GitHub readme page now. This might be fixed by adding some code in pack.py. For example, make sure the links work well on GitHub firstly, and before generating the .vsix file, change the link and recover it after generating.

Yes it will work around the problem in this way, and we can do it if it's indeed a limitation. But I think we'd better at first do some research, to find out why it doesn't work on Github website, and see if it can be solved directly in a regular/official approach.

Sen-real commented 2 years ago

What's your idea, @Higurashi-kagome?

Higurashi-kagome commented 2 years ago

I agree, @Sen-real . I will try to find a better solution but there is something else I need to do, so I am going to come back after lunch.

Sen-real commented 2 years ago

Cool, thanks a lot, @Higurashi-kagome!

Higurashi-kagome commented 2 years ago

I updated the readme file and it works well on GitHub now. But there is something wrong when the packing script uses vsce, I'm not interested in this and maybe it's just some config issues of the npm on my computer, so could you please test the links on VSCode? @Sen-real

Sen-real commented 2 years ago

I updated the readme file and it works well on GitHub now. But there is something wrong when the packing script uses vsce, I'm not interested in this and maybe it's just some config issues of the npm on my computer, so could you please test the links on VSCode? @Sen-real

@Higurashi-kagome I tried, and the links worked very well in VSCode. Thanks a lot!